/*
 * File Name     : @(#)UserContextPlaceHolder.java
 * Creation Date : Mar 2, 2009
 * Author        : anirudh
 * 
 * Copyright 2009 Anirudh Vyas
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hcis.core.engine.user.context;

import hcis.model.annotation.HCISEntity;

/**
 * User context placeholder, for reference (the current place holder derives the idea from the same pattern) : <a href="http://www.corej2eepatterns.com/Patterns2ndEd/ContextObject.htm"> Context Object
 * Design pattern </a>
 * 
 * @author avyas
 */
@HCISEntity
public final class UserContextPlaceHolder {

	/**
	 * bound user profile instance.
	 */
	private static IUserContext userContext;

	/**
	 * Default no argument constructor, suppressed.
	 */
	private UserContextPlaceHolder() {
		super();
	}

	/**
	 * Gets the userContext.
	 * 
	 * @return the userContext to get.
	 */
	public static final IUserContext getUserContext() {
		return userContext;
	}

	/**
	 * Sets the userContext.
	 * 
	 * @param pUserProfile
	 *            the userContext to set.
	 */
	public static final void setUserContext(final IUserContext pUserProfile) {
		UserContextPlaceHolder.userContext = pUserProfile;
	}
}
